Access APIs

Function

Description

Version

Examples

addAnalystProfile

Add an Analyst User Profile

2023.10

★

◉

addDomainSettings

Add new AD LDAP server

2023.10

◉

addProProfile

Add a Professional User Profile

2023.10

★

◉

addScientistProfile

Add a Scientist User Profile

2023.10

★

◉

addUserToRole

Add a user to a Role

2023.10

★

◉

addUsersToRole

Add Users to a Role

2023.10

◉

addViewerProfile

Add a Viewer User Profile

2023.10

★

◉

changeRoleAdGroups

Modify Active Directory Groups in a Role

2023.10

★

◉

changeUserLicense

Change a User’s License Type

2023.10

◉

createRole

Create a Security Role

2023.10

★

◉

createRoles

Create Security Roles

2023.10

★

◉

createTenant

Create a Tenant

2023.10

★

◉

createTenants

Create Multiple Tenants

2023.10

◉

createUserAd

Create a new user (ACTIVE DIRECTORY)

2023.10

★

◉

◉

createUserDb

Create a new user (DATABASE)

2023.10

★

◉

◉

createUserOpenId

Create a new user (OpenID)

2023.10

◉

◉

createUserSaml

Create a new user (SAML)

2023.10

★

◉

◉

createUsersAd

Create multiple users (ACTIVE DIRECTORY)

2023.10

◉

◉

createUsersDb

Create multiple users (Internal / Database)

2023.10

◉

◉

createUsersOpenId

Create multiple users (OpenID)

2023.10

◉

◉

createUsersSaml

Create multiple users (SAML)

2023.10

◉

◉

deleteProfile

Removes a user profile from the system

2023.10

★

◉

deleteRole

Delete a Role

2023.10

★

◉

deleteTenants

Delete Tenants

2023.10

★

◉

deleteUser

Delete a User

2023.10

★

◉

◉

findRoles

Find Security Roles

2023.10

★

◉

getAllAnalystProfiles

Gets a listing all Analyst profiles

2023.12

◉

◉

getAllProfessionalProfiles

Gets a listing all Professional profiles

2023.12

◉

◉

getAllRoles

Get All Roles

2023.10

◉

getAllScientistProfiles

Gets a listing all Scientist profiles

2023.12

◉

◉

getAllTenants

Get all Tenants

2023.10

◉

getAllViewerProfiles

Gets a listing all Viewer profiles

2023.12

◉

◉

getDefaultTenant

Get the default tenant ID

2023.10

★

◉

getGroupsByRole

Get Active Directory Groups for a Role

2023.10

★

◉

getLicenseCount

Get Tenant License Count

2023.10

◉

getLicenseExpirationDate

Get License Expiration Date

2023.10

◉

getLicenseValidationStatus

Get License Status

2023.10

◉

getMe

Gets details for the current user.

2023.10

★

◉

◉

◉

◉

◉

◉

getProfileForUser

Returns the profile assigned to the specified user

2023.10

◉

getPublicRoles

Get All Public Roles

2023.10

◉

getPublicRolesByTenant

Get All Public Roles for a Tenant

2023.10

◉

getRoleById

Get a Security Role by ID

2023.10

◉

getRolesByUser

Get all Roles for a User

2023.10

◉

getRolesbyProfile

Returns a list of roles assigned to the specified user profile

2023.10

★

◉

getTenantByName

Get Tenant by Name

2023.10

★

◉

getTenantUnusedLicenseCount

Get Available License Count for a Tenant

2023.10

★

◉

getTenantUsersByUserType

Get a Tenant's Users with specific license type

2023.10

★

◉

getUser

Get a User via ID

2023.10

◉

getUserByOpenIdPrincipalName

Get a User by UPN (OpenID)

2023.10

◉

getUserBySamlPrincipalName

Get a User by UPN (SAML)

2023.10

★

◉

getUserLastLogin

Get User Last Login Timestamp

2023.10

◉

getUserStatusById

Get User's System Status by User ID

2023.10

★

◉

getUserStatusByName

Get User's System Status by Name

2023.10

◉

getUsersByCurrentTenant

Get the Current Tenant's Users

2023.10

◉

getUsersByName

Get a User by UserName

2023.12

★

◉

getUsersByRole

Get all Users in a Role

2023.10

◉

getUsersByTenant

Get a Tenant's Users

2023.10

◉

searchAdGroups

Search AD Groups

2023.10

◉

searchAdGroupsForUser

Search User’s AD Groups

2023.10

★

◉

searchAdUsers

Search for Active Directory users

2023.10

★

◉

searchAdUsersForGroups

Search Active Directory Group Members

2023.10

◉

setUserAdministrationLevel

Set User's Administration Level

2023.10

◉

toggleUserStatus

Change User's Status

2023.10

◉

updateDomainAdminPermissions

Update Domain Admin Permissions

2023.10

◉

updateRoleProfiles

Update Role Profiles

2023.10

★

◉

updateTenant

Update a Tenant

2023.10

◉

updateTenantSeats

Updates a tenant seats

2023.10

◉

updateUserAd

Update user settings (ACTIVE DIRECTORY)

2023.10

★

◉

◉

updateUserDb

Update user settings (Internal / DATABASE)

2023.10

◉

◉

updateUserOpenId

Update user settings (OpenID)

2023.10

◉

◉

updateUserRoles

Update a User’s Roles

2023.10

◉

updateUserSaml

Update user settings (SAML)

2023.10

◉

◉

updateUsersAd

Update user settings (ACTIVE DIRECTORY)

2023.10

★

◉

◉

updateUsersDb

Update user settings (Internal / DATABASE)

2023.10

★

◉

◉

updateUsersOpenId

Update settings for multiple users (OpenID)

2023.10

◉

◉

updateUsersPhones

Update phones of users

2023.10

◉

updateUsersSaml

Update settings for multiple users (SAML)

2023.10

★

◉

◉